Add comments to protobuf files about specifying ledgers #3398
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Requested the devx people for review, since they pointed this out. |
Stormtv
previously approved these changes
May 12, 2020
mDuo13
reviewed
May 12, 2020
|
@mDuo13 gRPC and the JSON API use the same code underneath. If the comments are true for JSON, they are true for gRPC. Edit: they use the same code for tx and account_tx, but account_info is a different codepath |
keefertaylor
previously approved these changes
May 13, 2020
amiecorso
previously approved these changes
May 13, 2020
| @@ -23,7 +23,11 @@ message GetTransactionRequest { | |||
| // if true, return data in binary format. defaults to false | |||
| bool binary = 2; | |||
|
|
|||
| // search only specified range. optional | |||
| // If the transaction is not found, server will report whether the entire | |||
| // specified range is searched. The value is contained in the error message. | |||
cjcobb23
dismissed stale reviews from amiecorso, keefertaylor, and Stormtv
via
e1351bd
|
@amiecorso @Stormtv can you approve this if it looks good? |
Stormtv
approved these changes
May 28, 2020
cjcobb23
added
the
Passed
amiecorso
approved these changes
Jun 24, 2020
This was referenced Jun 25, 2020
Closed
Closed
Closed
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Specifying a ledger has a lot of gotchas. For
GetTransaction, the ledger range is only used for error handling, and searched_all is part of the error message, as opposed to the protobuf response. ForGetAccountInfo,SHORTCUT_VALIDATEDreturns the most up to date data; however, usingSHORTCUT_VALIDATEDforGetAccountTransactionHistoryresults in only transactions from the most recently validated ledger being returned. I added some comments to point out these nuances more clearly.This change is